DescribeAvailableResource

Description

call DescribeAvailableResource to query the resource list of an available area. You can query the resource list of an available zone when creating an instance (RunInstances) or modifying the instance type (ModifyInstanceSpec).

Request Method

POST

Request Path

/apsara/route/Ecs/DescribeAvailableResource

Request Parameters Common Parameters

Name	Location	Type	Required	Sample value	Description
DedicatedHostId	BODY	string	No	dh-bp165p6xk2tlw61e****	proprietary host ID.
IoOptimized	BODY	string	No	optimized	is it an I/O optimized instance. Value range: none: non-I/O optimized instance optimized:I/O optimized instance default value: optimized.
ZoneId	BODY	string	No	cn-hangzhou-a	zone ID. default value: none, which means that the available areas under the current region are randomly assigned, and the resources that meet the query criteria of all available areas under this region (RegionId) are returned.
DestinationResource	BODY	string	Yes	InstanceType	the type of resource to query. Value range: Zone: zone IoOptimized:I/O optimization InstanceType: instance type SystemDisk: system disk DataDisk: data disk Network: network type ddh: dedicated host Please refer to the interface description above for the value DestinationResource of the parameter.
Memory	BODY	float	No	8.0	Description This parameter is not open for use.
ResourceType	BODY	string	No	instance	resource type. Value range: instance:ECS instance disk: cloud disk ddh: dedicated host
version	BODY	string	No	2016-01-01	version of api
SystemDiskCategory	BODY	string	No	cloud_ssd	system disk type. Value range: cloud: ordinary cloud disk cloud_efficiency: efficient cloud disk cloud_ssd:SSD cloud disk ephemeral_ssd: local SSD cloud_essd:ESSD cloud disk If the parameter DestinationResource values are SystemDisk, InstanceType or DataDisk, the parameter SystemDiskCategory is not required. default value: cloud_efficiency.
NetworkCategory	BODY	string	No	vpc	network type. Value range: vpc: vpc classic: Classic Network
Cores	BODY	integer	No	2	Description This parameter is not open for use.
regionId	BODY	string	Yes	No sample value for this parameter.	region id
RegionId	BODY	string	Yes	cn-hangzhou	target region ID. You can call the DescribeRegions to view the latest Alibaba Cloud region list.
InstanceType	BODY	string	No	ecs.g5.large	Description This parameter is not open for use.
DataDiskCategory	BODY	string	No	cloud_ssd	data disk type. Value range: cloud: ordinary cloud disk cloud_efficiency: efficient cloud disk cloud_ssd:SSD cloud disk ephemeral_ssd: local SSD cloud_essd:ESSD cloud disk

Return data

Name	Type	Sample value	Description
RequestID	string	1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DC	Request id

Example

Successful Response example

{
 "RequestID":"1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DC"
}

Failed Response example

{
 "errorSample":
 {
  "resultCode":-1,
  "resultMsg":"system error",
  "result":null
 }

}

---

title: DescribeDeploymentSets

sidebar_position: 3

DescribeDeploymentSets

Description

call DescribeDeploymentSets to query the attribute list of one or more deployment sets.

Request Method

POST

Request Path

/apsara/route/Ecs/DescribeDeploymentSets

Request Parameters Common Parameters

Name	Location	Type	Required	Sample value	Description
PageSize	BODY	integer	No	10	the number of rows per page set during paging query. Maximum value: 50. default value: 10.
PageNumber	BODY	integer	No	1	page number of deployment set list. starting value: 1. default value: 1.
DeploymentSetIds	BODY	string	No	["ds-bp67acfmxazb4ph***", "ds-bp67acfmxazb4pi ***",… "ds-bp67acfmxazb4pj***"]	deployment set ID list. The value can be a JSON array composed of multiple deployment set IDs, which can support up to 100 IDs, separated by commas (,).
regionId	BODY	string	Yes	No sample value for this parameter.	region id
NetworkType	BODY	string	No	null	the network type of the instance in the deployment set. description to improve compatibility, please try to use other parameters.
Strategy	BODY	string	No	Availability	deployment policy. Value range: LooseDispersion: as scattered as possible. LooseAggregation: try to aggregate. StrictAggregation: strict aggregation. StrictDispersion: strictly dispersed. default value: LooseDispersion. If the deployment granularity is Switch, four deployment policies can be supported. If the deployment granularity is Rack or Host, you can only choose to disperse as much as possible or strictly disperse.
DeploymentSetName	BODY	string	No	FinanceDeploymen****	deployment set name.
RegionId	BODY	string	Yes	cn-qingdao-env17-d01	the region ID of the deployment set. You can call the DescribeRegions to view the latest Alibaba Cloud region list.
Granularity	BODY	string	No	null	deployment granularity. Value range: Host: host, which means that the minimum scheduling granularity is a physical server. Rack: The minimum scheduling granularity is one rack. Switch: The minimum scheduling granularity is a network switch. default value: Host.
Domain	BODY	string	No	null	deployment domain. Value range: Default Switch default value: Default.
version	BODY	string	No	2016-01-01	version of api

Return data

Name	Type	Sample value	Description
RequestID	string	1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DC	Request id

Example

Successful Response example

{
 "RequestID":"1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DC"
}

Failed Response example

{
 "errorSample":
 {
  "resultCode":-1,
  "resultMsg":"system error",
  "result":null
 }

}